home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / programs / dman310.zip / DOOREDIT.DOC < prev    next >
Text File  |  1993-04-25  |  12KB  |  230 lines
  1.  
  2.                            DoorMan Menu Editor v3.00
  3.                                  Documentation
  4.  
  5. ┌──────────────────────────────────┐
  6. │                                  │
  7. │      !! DESQView Users !!!       │
  8. │                                  │
  9. │ This program uses direct screen  │
  10. │ writes!  Make sure to tell DV    │
  11. │ when you set up a window for it. │
  12. │ Under DV 2.41, the program will  │
  13. │ run fine in a 256k window.       │
  14. └──────────────────────────────────┘
  15.  
  16. OVERVIEW
  17.  
  18. DoorEdit is a companion program for DoorMan.  This is the utility used to
  19. create and edit the "catalog" of doors available on your system and to
  20. add/update all information the Door may need.  The doors are divided into
  21. categories to make them easier to find.  DoorMan is limited to 15 categories
  22. with 15 doors in each for a grand total of 225 doors.  If you want to run
  23. more than 225, get in touch with me and I'll see what I can do about upping
  24. the limit!  The first time you run the program, you will be prompted to fill
  25. some questions.  These are to find out about your system, and to set up
  26. the defaults for everything in the program.  You should attempt to answer
  27. every question.  If you're not sure what to answer, simply hit F2 and context
  28. sensitive help will pop up.  You'll only have to do this one time!  You can
  29. go back and change the information later, but you need to get as much of
  30. it as possible the first time through.  The single most important question
  31. in there is the number of nodes your BBS has.  This will determine how many
  32. nodes the program will prompt you to enter information for.  If you don't
  33. get the info in there for all the nodes, DoorMan will not be able to use
  34. them.  There are a few things that can be left blank, for instance, any 
  35. time it asks you for a screen name, you can leave it blank, same goes for
  36. messages.  You can change them later if you like.  Once you've completed 
  37. the list of question, the program will create a file called DoorMan.Def.
  38.  
  39.  
  40. OPERATION
  41.  
  42. Starting with this version, just about every single prompt in the program
  43. has context sensitive help available.  Therefore, the docs aren't going
  44. to be as in-depth as before.  If you're unsure what to do, hit F2!!
  45.  
  46.  
  47. CATEGORIES
  48.  
  49. A category is defined by a name, four character abbreviation, a security
  50. level, Hide Flag, and a Menu Style.  When you tell the program to add a
  51. category, which you must do before you add any doors, you will be
  52. presented with a data input screen.  On this screen, you will fill out
  53. everything about this category.  You will also notice that the defaults
  54. you defined in the initial setup will automatically come up.  Following
  55. is a brief explanation of each item:
  56.  
  57.   Name:  This is what will be displayed in the Main Menu of the door.
  58.  
  59.   Abbr:  This abbreviation is used to reference the category internally.
  60.  
  61.   SecLv:  This is the minimum security level to access this category.
  62.           User's who have this security level or higher will have
  63.           access.
  64.  
  65.   Hide:  If set to Yes, user's who do not have access to the category
  66.          will not even see it!  If set to No, user's who do not have
  67.          access will be shown the name with a red X at the end.  If
  68.          they attempt to choose it, the will be told that their 
  69.          security level does not allow access to this item.
  70.  
  71.   Menu Style:  When you come to this item, you will be presented with
  72.                a list of the available styles.  Simply point the 
  73.                cursor at one and hit enter.  If you choose Random,
  74.                each time the menu is displayed DoorMan will choose one
  75.                of the menu styles.  If you want to take a peek at
  76.                them, simply choose Show Styles.
  77.  
  78.  
  79. To edit a category, you simply choose one from the list, and the same
  80. screen will pop up with that categories information in it.  To delete
  81. one, you simply choose it from the list.  To delete a category, you must
  82. first delete all the doors in the category, safety precaution!
  83.  
  84.  
  85. DOORS
  86.  
  87. When you go to add a door, you must first tell the program which category
  88. the door goes in.  After that, each door in your menus is defined using the
  89. following items:
  90.  
  91.      Door Name:  This is the name as you want it to appear in the menu.
  92.                  Can be anything you like.
  93.  
  94.      Abbreviation:  This is the four character "code" which is written to
  95.                     the DoorMan.Dat file each time the door is used.
  96.  
  97.      Description:  This will also appear in the menu.  Can be anything.
  98.  
  99.      Sponsor:  This was added due to the fact that all the doors on my
  100.                system have been sponsored.  For sponsoring a door, I 
  101.                promised my users that they would get recognition.  Before
  102.                DoorMan, I had an intro bulletin for each door.  Now, I
  103.                Have this.  If you put anything here, it will be displayed
  104.                each time a user enters this door in a message like this:
  105.  
  106.                   This door was sponsored by <<Whatever you put here>>
  107.  
  108.                What I do on my board for "unregistered" doors is put:
  109.  
  110.                   -=> Your Name Could Be Here <=-  Cost $20
  111.  
  112.                Of course the $20 is adjusted to whatever the door costs
  113.                to register.  You'd be surprised how many users will send
  114.                the money to get their name displayed!!
  115.  
  116.      
  117.      Security Level:  This is the minimum SL required to enter the door.
  118.                       If a user has a SL equal to or greater than this,
  119.                       then they will have access to the door.  If this is
  120.                       set to 0, then all users will have access. 
  121.  
  122.      Nodes:  This tells DoorMan which nodes can use a door.  When you 
  123.              come to this field, you will be presented with a list of
  124.              nodes.  Ever how many you have told DoorMan you have. Simply
  125.              choose which nodes have access to this door by tagging them
  126.              with the spacebar.  When you're done, hit D.  When a user
  127.              logs on to a Node that does not have access to this door,
  128.              the door will not even show up in the menu! 
  129.  
  130.      Check Use:  This tells DoorMan whether or not to allow two users
  131.                  in the door at the same time.  If this is set to No,
  132.                  then DoorMan does no checking to see if the door is
  133.                  in use! If set to Yes, then it looks for a "use" file
  134.                  which is created when someone enters a door.  If it
  135.                  finds one, it will read it and tell the user attempting
  136.                  access:
  137.  
  138.                  Sorry!  <UserName> is using <Door Name> on node #.
  139.  
  140.      Registered:  If this option is turned on in the config file, DoorMan
  141.                   will look here for a Yes.  If it finds one, it will put
  142.                   a green * beside the door's description in the menus.
  143.  
  144.      Hide:  This decides whether or not the door should be shown to users
  145.             who do not have access.  If set to No, the door will show
  146.             up in the menu, but have a red X at the end.
  147.  
  148.      9600+:  If set to Yes, DoorMan will only allow users who are
  149.              connected at a baud rate of 9600 or greater to enter the
  150.              door.  This defaults to hidden.  Bear in mind, DoorMan 
  151.              has no way of actually telling what baud rate the user is
  152.              connected at!  It simply reads this information from the
  153.              caller info file.  Therefore, if your BBS software writes
  154.              the Locked baud rate to the file (as opposed to the connect
  155.              rate) this feature will not function properly!
  156.  
  157.      Locked:  If set to Yes, DoorMan will allow NO ONE in the door!
  158.               This is designed to be used when you are not using a
  159.               door but want to keep it in the menu.
  160.  
  161.      Use DTE: If set to Yes, DoorMan will write the locked baud rate
  162.               defined in Global Defaults - Node Information to the
  163.               caller info file instead of the connect rate.  Some 
  164.  
  165.               some doors DIE if you pass them a baud rate of 14,400
  166.               or 16,800.  This will make those doors work!
  167.  
  168.      Sysop Stats:  If No, your door usage for this door will not be
  169.                    recorded in the log files, bulletins, or graphs.
  170.  
  171.      Max Time:  When a user chooses a door, DoorMan will look at this
  172.                 value, compare it to the user's time left, and pass
  173.                 the lesser of the two to the door.  That is, if this
  174.                 is a non 0 value.  If it is set to 0 (or blank), DoorMan
  175.                 will pass the user's time left to the door.
  176.  
  177.      Opening Screen:  This is a place to insert a screen of your choice
  178.                       before this door loads.  It defaults to extensions
  179.                       of ANS for ANSI and ASC for non-ANSI.  If you put
  180.                       a name in here, DoorMan will look in the directory
  181.                       you have defined for Opening Screens for the 
  182.                       proper screen.  If it finds the file, it will 
  183.                       display it to the user and wait for a keypress.
  184.                       At present, these screens are not abortable!  If
  185.  
  186.                       the screen you put in is more than 24 lines long,
  187.                       DoorMan will insert Pauses where needed.
  188.  
  189.     Scores Files:  This is the name and extension of the scores files
  190.                    for this door.  When a user hits "S" from the menu
  191.                    with the cursor pointed at this door, DoorMan will
  192.                    first look in the directory you've defined for
  193.                    Scores, then in the door's directory for the correct
  194.                    file.  If it finds the file, it will be displayed.
  195.  
  196.     Door's Dir:  This is the actual path name to the Door.  This is
  197.                  what DoorMan will use when creating the bat file to
  198.                  run this door.  In other words, it will change dir
  199.                  to here then issue the commands to run the door.  This
  200.                  is also the directory where DoorMan will look for the
  201.                  scores files.
  202.  
  203.     Caller Info File:  This is the file that the door requires.  When
  204.                        you come to this field, you will be presented
  205.                        with a list of available files.  Simply choose
  206.                        one with the spacebar and hit D for Done.  When
  207.                        DoorMan runs this door, it will read whatever
  208.                        file you have called it with and write whatever
  209.                        file you put here.  The file will be created
  210.                        in the "Caller Info File Path" for the current
  211.                        node.  At the present time, DoorMan does not
  212.                        delete the files when the user returns.  This
  213.                        is primarily for testing purposes and may be
  214.                        changed in the future.
  215.  
  216.     Run Commands:  This is the actual commands to run the door.  There
  217.                    should be no reason for putting change directory
  218.                    commands in here!  In fact, if you do put them in
  219.                    here, DoorMan will most likely freak out!  On most
  220.                    doors, this will simply be the name of the EXE file
  221.                    and the name of the config file.  If you need to
  222.                    insert a node specific command, there are a number
  223.                    of symbols which will be replace when the door runs.
  224.                    Hit F2 for a list of these symbols from within the
  225.                    Run Command Editor.   
  226.                   
  227. That's it.  Once you've entered all these, the program will know how to
  228. handle the door.
  229.  
  230.